/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties.source;

import org.springframework.util.Assert;

/**
 * 当配置属性值无效时抛出的异常。
 *
 * @author Stephane Nicoll
 * @since 2.0.0
 */
@SuppressWarnings("serial")
public class InvalidConfigurationPropertyValueException extends RuntimeException {

	private final String name;

	private final Object value;

	private final String reason;

	/**
	 * 创建一个新的异常实例，指定属性名 {@code name}、属性值 {@code value} 及无效原因 {@code reason}。
	 * @param name 属性的规范名称
	 * @param value 属性值，可以为 {@code null}
	 * @param reason 描述值无效原因的人类可读文本。首字母大写，末尾带句号。可以包含多句话和换行。
	 */
	public InvalidConfigurationPropertyValueException(String name, Object value, String reason) {
		super("Property " + name + " with value '" + value + "' is invalid: " + reason);
		Assert.notNull(name, "Name must not be null");
		this.name = name;
		this.value = value;
		this.reason = reason;
	}

	/**
	 * 返回属性名称。
	 * @return 属性名
	 */
	public String getName() {
		return this.name;
	}

	/**
	 * 返回无效的属性值，可能为 {@code null}。
	 * @return 无效值
	 */
	public Object getValue() {
		return this.value;
	}

	/**
	 * 返回值无效的原因。
	 * @return 原因描述
	 */
	public String getReason() {
		return this.reason;
	}

}
